home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1997 #1 / Amiga Plus CD - 1997 - No. 01.iso / pd / programmierung / quickautodocks / iffparse.doc < prev    next >
Text File  |  1992-09-03  |  7KB  |  202 lines
  1. iffparse.library quick autodocs
  2.  
  3. NAME     : AllocIFF
  4. FUNCTION : create a new IFFHandle structure
  5. SYNOPSIS : iff=AllocIFF()
  6.             D0   -30
  7.  
  8. NAME     : AllocLocalItem
  9. FUNCTION : create a local context item structure
  10. SYNOPSIS : item=AllocLocalItem(type,id,ident,dataSize)
  11.             D0       -186       D0  D1  D2      D3
  12.  
  13. NAME     : CloseClipboard
  14. FUNCTION : close and free an open ClipboardHandle
  15. SYNOPSIS : CloseClipboard(clipHandle)
  16.                 -252          A0
  17.  
  18. NAME     : CloseIFF
  19. FUNCTION : close an IFF context
  20. SYNOPSIS : CloseIFF(iff)
  21.               -48    A0
  22.  
  23. NAME     : CollectionChunk
  24. FUNCTION : declare a chunk type for collection
  25. SYNOPSIS : error=CollectionChunk(iff,type,id)
  26.              D0        -138       A0  D0  D1
  27.  
  28. NAME     : CollectionChunks
  29. FUNCTION : declare many collection chunks at once
  30. SYNOPSIS : error=CollectionChunks(iff,propArray,numPairs)
  31.              D0        -144        A0     A1       D0
  32.  
  33. NAME     : CurrentChunk
  34. FUNCTION : get context node for current chunk
  35. SYNOPSIS : top=CurrentChunk(iff)
  36.             D0     -174      A0
  37.  
  38. NAME     : EntryHandler
  39. FUNCTION : add an entry handler to the IFFHandle context
  40. SYNOPSIS : error=EntryHandler(iff,type,id,position,handler,object)
  41.              D0      -102      A0  D0  D1    D2       A1     A2
  42.  
  43. NAME     : ExitHandler
  44. FUNCTION : add an exit handler to the IFFHandle context
  45. SYNOPSIS : error=ExitHandler(iff,type,id,position,handler,object)
  46.              D0     -108      A0  D0  D1    D2       A1     A2
  47.  
  48. NAME     : FindCollection
  49. FUNCTION : get a pointer to the current list of collection items
  50. SYNOPSIS : ci=FindCollection(iff,type,id)
  51.            D0      -162       A0  D0  D1
  52.  
  53. NAME     : FindLocalItem
  54. FUNCTION : return a local context item from the context stack
  55. SYNOPSIS : lci=FindLocalItem(iff,type,id,ident)
  56.             D0     -210       A0  D0  D1   D2
  57.  
  58. NAME     : FindProp
  59. FUNCTION : search for a stored property chunk
  60. SYNOPSIS : sp=FindProp(iff,type,id)
  61.            D0   -156    A0  D0  D1
  62.  
  63. NAME     : FindPropContext
  64. FUNCTION : get the property context for the current state
  65. SYNOPSIS : cn=FindPropContext(iff)
  66.            D0      -168        A0
  67.  
  68. NAME     : FreeIFF
  69. FUNCTION : deallocate an IFFHandle structure
  70. SYNOPSIS : FreeIFF(iff)
  71.              -54    A0
  72.  
  73. NAME     : FreeLocalItem
  74. FUNCTION : deallocate a local context item structure
  75. SYNOPSIS : FreeLocalItem(localItem)
  76.                 -204         A0
  77.  
  78. NAME     : GoodID
  79. FUNCTION : test if an identifier follows the IFF 85 specification
  80. SYNOPSIS : isok=GoodID(id)
  81.             D0   -258  D0
  82.  
  83. NAME     : GoodType
  84. FUNCTION : test if a type follows the IFF 85 specification
  85. SYNOPSIS : isok=GoodType(type)
  86.             D0    -264    D0
  87.  
  88. NAME     : IDtoStr
  89. FUNCTION : convert a longword identifier to a null-terminated string
  90. SYNOPSIS : str=IDtoStr(id,buf)
  91.             D0  -270   D0  A0
  92.  
  93. NAME     : InitIFF
  94. FUNCTION : initialize an IFFHandle structure as a user stream
  95. SYNOPSIS : InitIFF(iff,flags,streamHook)
  96.             -228    A0   D0      A1
  97.  
  98. NAME     : InitIFFasClip
  99. FUNCTION : initialize an IFFHandle as a clipboard stream
  100. SYNOPSIS : InitIFFasClip(iff)
  101.                -240       A0
  102.  
  103. NAME     : InitIFFasDOS
  104. FUNCTION : initialize an IFFHandle as a DOS stream
  105. SYNOPSIS : InitIFFasDOS(iff)
  106.                -234      A0
  107.  
  108. NAME     : LocalItemData
  109. FUNCTION : get pointer to user data for local context item
  110. SYNOPSIS : data=LocalItemData(localItem)
  111.             D0      -192          A0
  112.  
  113. NAME     : OpenClipboard
  114. FUNCTION : create a handle on a clipboard unit
  115. SYNOPSIS : ch=OpenClipboard(unitNumber)
  116.            D0     -246          D0
  117.  
  118. NAME     : OpenIFF
  119. FUNCTION : prepare an IFFHandle to read or write a new IFF stream
  120. SYNOPSIS : error=OpenIFF(iff,rwMode)
  121.              D0    -36    A0   D0
  122.  
  123. NAME     : ParentChunk
  124. FUNCTION : get the nesting context node for the given chunk
  125. SYNOPSIS : parent=ParentChunk(contextNode)
  126.              D0      -180          A0
  127.  
  128. NAME     : ParseIFF
  129. FUNCTION : parse an IFF file from an IFFHandle structure stream
  130. SYNOPSIS : error=ParseIFF(iff,control)
  131.              D0    -42     A0    D0
  132.  
  133. NAME     : PopChunk
  134. FUNCTION : pop top context node off context stack
  135. SYNOPSIS : error=PopChunk(iff)
  136.              D0    -90     A0
  137.  
  138. NAME     : PropChunk
  139. FUNCTION : specify a property chunk to store
  140. SYNOPSIS : error=PropChunk(iff,type,id)
  141.              D0     -114    A0  D0  D1
  142.  
  143. NAME     : PropChunks
  144. FUNCTION : declare many property chunks at once
  145. SYNOPSIS : error=PropChunks(iff,propArray,numPairs)
  146.              D0     -120     A0     A1       D0
  147.  
  148. NAME     : PushChunk
  149. FUNCTION : push a new context node on the context stack
  150. SYNOPSIS : error=PushChunk(iff,type,id,size)
  151.              D0     -84     A0  D0  D1  D2
  152.  
  153. NAME     : ReadChunkBytes
  154. FUNCTION : read bytes from the current chunk into a buffer
  155. SYNOPSIS : actual=ReadChunkBytes(iff,buf,numBytes)
  156.              D0        -60        A0  A1    D0
  157.  
  158. NAME     : ReadChunkRecords
  159. FUNCTION : read record elements from the current chunk into a buffer
  160. SYNOPSIS : actual=ReadChunkRecords(iff,buf,bytesPerRecord,numRecords)
  161.              D0        -72          A0  A1       D0           D1
  162.  
  163. NAME     : SetLocalItemPurge
  164. FUNCTION : set purge vector for a local context item
  165. SYNOPSIS : SetLocalItemPurge(localItem,purgeHook)
  166.                   -198           A0        A1
  167.  
  168. NAME     : StopChunk
  169. FUNCTION : declare a chunk which should cause ParseIFF to return
  170. SYNOPSIS : error=StopChunk(iff,type,id)
  171.              D0     -126    A0  D0  D1
  172.  
  173. NAME     : StopChunks
  174. FUNCTION : declare many stop chunks at once
  175. SYNOPSIS : error=StopChunks(iff,propArray,numPairs)
  176.              D0     -132     A0     A1       D0
  177.  
  178. NAME     : StopOnExit
  179. FUNCTION : declare a stop condition for exiting a chunk
  180. SYNOPSIS : error=StopOnExit(iff,type,id)
  181.              D0     -150     A0  D0  D1
  182.  
  183. NAME     : StoreItemInContext
  184. FUNCTION : store local context item in given context node
  185. SYNOPSIS : StoreItemInContext(iff,localItem,contextNode)
  186.                   -222         A0     A1         A2
  187.  
  188. NAME     : StoreLocalItem
  189. FUNCTION : insert a local context item into the context stack
  190. SYNOPSIS : error=StoreLocalItem(iff,localItem,position)
  191.              D0       -216       A0     A1       D0
  192.  
  193. NAME     : WriteChunkBytes
  194. FUNCTION : write data from a buffer into the current chunk
  195. SYNOPSIS : error=WriteChunkBytes(iff,buf,numBytes)
  196.              D0       -66         A0  A1    D0
  197.  
  198. NAME     : WriteChunkRecords
  199. FUNCTION : write records from a buffer to the current chunk
  200. SYNOPSIS : error=WriteChunkRecords(iff,buf,recsize,numrec)
  201.              D0         -78         A0  A1    D0     D1
  202.